/******************************************************************************

 @file  mac_timer.h

 @brief Timer interface for high level MAC.

 Group: WCS, LPC
 Target Device: cc13x2_26x2

 ******************************************************************************
 
 Copyright (c) 2006-2021, Texas Instruments Incorporated
 All rights reserved.

 IMPORTANT: Your use of this Software is limited to those specific rights
 granted under the terms of a software license agreement between the user
 who downloaded the software, his/her employer (which must be your employer)
 and Texas Instruments Incorporated (the "License"). You may not use this
 Software unless you agree to abide by the terms of the License. The License
 limits your use, and you acknowledge, that the Software may not be modified,
 copied or distributed unless embedded on a Texas Instruments microcontroller
 or used solely and exclusively in conjunction with a Texas Instruments radio
 frequency transceiver, which is integrated into your product. Other than for
 the foregoing purpose, you may not use, reproduce, copy, prepare derivative
 works of, modify, distribute, perform, display or sell this Software and/or
 its documentation for any purpose.

 YOU FURTHER ACKNOWLEDGE AND AGREE THAT THE SOFTWARE AND DOCUMENTATION ARE
 PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
 INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, TITLE,
 NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL
 TEXAS INSTRUMENTS OR ITS LICENSORS BE LIABLE OR OBLIGATED UNDER CONTRACT,
 NEGLIGENCE, STRICT LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR OTHER
 LEGAL EQUITABLE THEORY ANY DIRECT OR INDIRECT DAMAGES OR EXPENSES
 INCLUDING BUT NOT LIMITED TO ANY INCIDENTAL, SPECIAL, INDIRECT, PUNITIVE
 OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF PROCUREMENT
 OF SUBSTITUTE GOODS, TECHNOLOGY, SERVICES, OR ANY CLAIMS BY THIRD PARTIES
 (INCLUDING BUT NOT LIMITED TO ANY DEFENSE THEREOF), OR OTHER SIMILAR COSTS.

 Should you have any questions regarding your right to use this Software,
 contact Texas Instruments Incorporated at www.TI.com.

 ******************************************************************************
 
 
 *****************************************************************************/

#ifndef MAC_TIMER_H
#define MAC_TIMER_H

/* ------------------------------------------------------------------------------------------------
 *                                               Includes
 * ------------------------------------------------------------------------------------------------
 */
#include "mac_high_level.h"

/* ------------------------------------------------------------------------------------------------
 *                                               Macros
 * ------------------------------------------------------------------------------------------------
 */

#define MAC_BEACON_INTERVAL(x)        (((uint32) MAC_A_BASE_SUPERFRAME_DURATION) << (x))
#define MAC_SF_INTERVAL(x)            MAC_BEACON_INTERVAL(x)

/* ------------------------------------------------------------------------------------------------
 *                                           Typedefs
 * ------------------------------------------------------------------------------------------------
 */

typedef struct macTimer_s
{
  struct macTimer_s     *pNext;                     /* next timer in queue */
  int32                 symbol;                     /* timer expiration count */
  void                  (*pFunc)(uint8 parameter);  /* timer callback function */
  uint8                 parameter;                  /* callback function parameter */
} macTimer_t;

typedef struct macTimerHeader_s
{
  struct macTimer_s     * pNext;
} macTimerHeader_t;

/* ------------------------------------------------------------------------------------------------
 *                                           Globals
 * ------------------------------------------------------------------------------------------------
 */
extern macTimer_t *macTimerActive;

/* ------------------------------------------------------------------------------------------------
 *                                           Function Prototypes
 * ------------------------------------------------------------------------------------------------
 */

MAC_INTERNAL_API void macTimerInit(void);
MAC_INTERNAL_API void macTimer(macTimer_t *pTimer, uint32 backoffs);
MAC_INTERNAL_API void macTimerCancel(macTimer_t *pTimer);
MAC_INTERNAL_API void macTimerStart(uint32 initTime, uint8 beaconOrder);
MAC_INTERNAL_API uint32 macTimerGetTime(void);
MAC_INTERNAL_API void macTxBeaconFrame(void);
MAC_INTERNAL_API void macTimerAligned(macTimer_t *pTimer, uint32 backoffs);
MAC_INTERNAL_API void macTimerRealign(macRx_t *pRxBeacon, uint8 beaconOrder);
MAC_INTERNAL_API void macTimerSyncRollover(uint8 beaconOrder);
MAC_INTERNAL_API void macTimerSetRollover(uint8 beaconOrder);
MAC_INTERNAL_API bool macTimerCheckUnAlignedQ(macTimer_t *pTimer);
MAC_INTERNAL_API void macTimerUpdActive(macTimer_t *pTimer);
#endif /* MAC_TIMER_H */

